SecuGen.FDxSDKPro.jni

Class JSGFPLib

java.lang.Object

SecuGen.FDxSDKPro.jni.JSGFPLib

public class JSGFPLib
extends java.lang.Object

This class is the main entrypoint to the SecuGen device and algorithm functionality. When the JSGFPLib class is instantiated, it loads the JNISGFPLIB library which in turn calls the functions in the SecuGen SGFPLIB library. These libraries are required in the system path before the JSGFPLib class can be used.

Field Summary

Fields

Modifier and Type	Field and Description
long	jniLoadStatus SecuGen JNI library initialization status.
static int	MAX_IMAGE_HEIGHT_ALL_DEVICES 336 - FDU03 image height is 300 pixels and FDU04 image height is 336 pixels.
static int	MAX_IMAGE_WIDTH_ALL_DEVICES 260 - FDU03 image width is 260 pixels and FDU04 image height is 258 pixels.

Constructor Summary

Constructors

Constructor and Description
JSGFPLib() Creates a new instance of JSGFPLib.

Method Summary

Modifier and Type	Method and Description
long	Close() Close SecuGen native library.
long	CloseDevice() Close the attached SecuGen fingerprint sensor.
long	ComputeNFIQ(byte[] imgBuf, long width, long height) Compute NIST Fingerprint Image Quality score for a 500DPI 8 bit grayscale fingerprint image.
long	ComputeNFIQEx(byte[] imgBuf, long width, long height, long ppi) Compute NIST Fingerprint Image Quality score for an 8 bit grayscale fingerprint image.
long	Configure(long hwnd)
long	CreateTemplate(SGFingerInfo fpInfo, byte[] rawImage, byte[] minTemplate) Create a fingerprint template using the currently selected template format.
long	EnumerateDevice(int[] ndevs, SGDeviceList[] devList) Returns an enumerated list of attached SecuGen devices.
long	GetAnsiMatchingScore(byte[] ansiTemplate1, long sampleNum1, byte[] ansiTemplate2, long sampleNum2, int[] score) Get matching score of specific samples in two ANSI378 minutiae templates.
long	GetAnsiTemplateInfo(byte[] ansiTemplate, SGANSITemplateInfo templateInfo) Get the template header information for a template of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378 templates.
long	GetDeviceInfo(SGDeviceInfoParam info) Gets device information for the attached SecuGen fingerprint device.
long	GetImage(byte[] buffer) Captures a fingerprint image from the fingerprint device.
long	GetImageEx(byte[] buffer, long timeout, long dispWnd, long quality) Captures fingerprint images from the reader until the quality of the image is greater than the value of the quality parameter.
long	GetImageQuality(long width, long height, byte[] imgBuf, int[] quality) Get the quality of a fingerprint image.
long	GetIsoMatchingScore(byte[] isoTemplate1, long sampleNum1, byte[] isoTemplate2, long sampleNum2, int[] score) Get matching score of specific samples in two ISO19794 minutiae templates.
long	GetIsoTemplateInfo(byte[] isoTemplate, SGISOTemplateInfo templateInfo) Get the template header information for a template of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794 templates.
long	GetIsoTemplateSizeAfterMerge(byte[] isoTemplate1, byte[] isoTemplate2, int[] size) Get the size of the template produced by merging to templates of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794 templates.
long	GetLastError() Get the the last error that was set by the SecuGen SDK.
long	GetMatchingScore(byte[] minTemplate1, byte[] minTemplate2, int[] score) Get matching score of two fingerprint minutiae templates.
long	GetMatchingScoreEx(byte[] minTemplate1, short tempateType1, long sampleNum1, byte[] minTemplate2, short tempateType2, long sampleNum2, int[] score) Get matching score of specific samples in two minutiae templates of any type.
long	GetMaxTemplateSize(int[] size) Get the maximum template size for the currently selected template format.
long	GetMinexVersion(int[] extractor, int[] matcher) Gets version of MINEX Compliant algorithms used in this SDK.
long	GetNumOfMinutiae(short templateType, byte[] minTemplate, int[] numOfMinutiae) Get a count of the number of minutiae in a fingerprint template.
long	GetTemplateSize(byte[] buf, int[] size) Get the size of a fingerprint template.
long	GetTemplateSizeAfterMerge(byte[] ansiTemplate1, byte[] ansiTemplate2, int[] size) Get the size of the template produced by merging to templates of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378 templates.
long	Init(long devName) Initialize the SecuGen libraries using attached SecuGen fingerprint sensor.
long	InitEx(long width, long height, long dpi) Initializes the SecuGen libraries using image parameters.
long	MatchAnsiTemplate(byte[] ansiTemplate1, long sampleNum1, byte[] ansiTemplate2, long sampleNum2, long secuLevel, boolean[] matched) Get matching result of specific samples in two ANSI378 minutiae templates.
long	MatchIsoTemplate(byte[] isoTemplate1, long sampleNum1, byte[] isoTemplate2, long sampleNum2, long secuLevel, boolean[] matched) Get matching result of specific samples in two ISO19794 minutiae templates.
long	MatchTemplate(byte[] minTemplate1, byte[] minTemplate2, long secuLevel, boolean[] matched) Get matching result of two fingerprint minutiae templates .
long	MatchTemplateEx(byte[] minTemplate1, short tempateType1, long sampleNum1, byte[] minTemplate2, short tempateType2, long sampleNum2, long secuLevel, boolean[] matched) Get matching result of specific samples in two minutiae templates of any type.
long	MergeAnsiTemplate(byte[] ansiTemplate1, byte[] ansiTemplate2, byte[] outTemplate) Merge two ANSI378 templates and return a merged template of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378 templates.
long	MergeIsoTemplate(byte[] isoTemplate1, byte[] isoTemplate2, byte[] outTemplate) Merge two ISO19794 templates and return a merged template of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794 templates.
long	OpenDevice(long devId) Open the attached SecuGen fingerprint sensor.
long	SetBrightness(long brightness) Sets the brightness value of the attached device.
long	SetLedOn(boolean on) Controls the LED of the fingerprint sensor.
long	SetTemplateFormat(short format) Set the template format to be used for the current session.
java.lang.String	toString() Returns JSGFPLib native library version string.
long	WSQDecode(byte[] fingerImageOut, int[] width, int[] height, int[] pixelDepth, int[] ppi, int[] lossyFlag, byte[] wsqImage, int wsqImageSize) Decode the WSQ image and return the RAW image.
long	WSQEncode(byte[] wsqImageOut, float wsqBitRate, byte[] fingerImage, int width, int height, int pixelDepth, int ppi) Encode a WSQ image.
long	WSQGetDecodedImageSize(int[] fingerImageOutSize, byte[] wsqImage, int wsqImageSize) Get the size of the RAW image contained in the WSQ image file.
long	WSQGetEncodedImageSize(int[] wsqImageOutSize, float wsqBitRate, byte[] fingerImage, int width, int height, int pixelDepth, int ppi) Get the size of the compressed WSQ image that will be returned when the RAW image file is compressed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

jniLoadStatus

public long jniLoadStatus

SecuGen JNI library initialization status. This variable is populated when the JSGFPLib open() method is called. For any values other than SGFDxError.ERROR_NONE, the library is in an unstable state.
Possible values:
♦ SGFDxErrorCode.ERROR_NONE
♦ SGFDxErrorCode.SGFDX_ERROR_JNI_DLLLOAD_FAILED

See Also:

Open(), SGFDxErrorCode

MAX_IMAGE_WIDTH_ALL_DEVICES

public static final int MAX_IMAGE_WIDTH_ALL_DEVICES

260 - FDU03 image width is 260 pixels and FDU04 image height is 258 pixels.

See Also:

Constant Field Values

MAX_IMAGE_HEIGHT_ALL_DEVICES

public static final int MAX_IMAGE_HEIGHT_ALL_DEVICES

336 - FDU03 image height is 300 pixels and FDU04 image height is 336 pixels.

See Also:

Constant Field Values

Constructor Detail

JSGFPLib

public JSGFPLib()

Creates a new instance of JSGFPLib. Also calls open() method to initialize the native library.

See Also:

Open()

Method Detail

Close

public long Close()

Close SecuGen native library. This should be called before exiting an application or when the JSGFPLib object is about to be deleted.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

Open(), SGFDxErrorCode

toString

public java.lang.String toString()

Returns JSGFPLib native library version string.

Overrides:

toString in class java.lang.Object

EnumerateDevice

public long EnumerateDevice(int[] ndevs,
                            SGDeviceList[] devList)

Returns an enumerated list of attached SecuGen devices.

Parameters:

ndevs - A single element int array that will contain the number of attached devices.

devList - An array of SGDeviceList objects that will contain info about the attached devices.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, SGDeviceList

GetLastError

public long GetLastError()

Get the the last error that was set by the SecuGen SDK.

See Also:

SGFDxErrorCode

Init

public long Init(long devName)

Initialize the SecuGen libraries using attached SecuGen fingerprint sensor. This method should be called after Open() is called.

Parameters:

devName - The port address of the attached SecuGen sensor to be opened.
Allowed values:
♦ SGFDxDeviceName.SG_DEV_AUTO
♦ SGFDxDeviceName.SG_DEV_FDP02
♦ SGFDxDeviceName.SG_DEV_FDU02
♦ SGFDxDeviceName.SG_DEV_FDU03
♦ SGFDxDeviceName.SG_DEV_FDU04

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxDeviceName, SGFDxErrorCode

InitEx

public long InitEx(long width,
                   long height,
                   long dpi)

Initializes the SecuGen libraries using image parameters. Only 8bits per pixel raw images are supported.

Parameters:

width - The width of the image to be processed.

height - The width of the image to be processed.

dpi - The resolution of the image to be processed.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode

SetTemplateFormat

public long SetTemplateFormat(short format)

Set the template format to be used for the current session.

Parameters:

format - The fingerprint template to be used by the SecuGen algorithms.
Allowed values:
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_SG400

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, SGFDxTemplateFormat

OpenDevice

public long OpenDevice(long devId)

Open the attached SecuGen fingerprint sensor. Only SDU04P (Hamster IV) and SDU03P (Hamster Plus) are supported.

Parameters:

devId - The device ID of the attached SecuGen sensor to be opened.
Allowed values:
♦ SGFDxDeviceName.SG_DEV_AUTO

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxDeviceName, SGFDxErrorCode

CloseDevice

public long CloseDevice()

Close the attached SecuGen fingerprint sensor. Only SDU04P (Hamster IV) and SDU03P (Hamster Plus) are supported.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode

GetDeviceInfo

public long GetDeviceInfo(SGDeviceInfoParam info)

Gets device information for the attached SecuGen fingerprint device.

Parameters:

info - A SGDeviceInfoParam object whose fields are populated with values for the attached fingerprint device.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, SGDeviceInfoParam

Configure

public long Configure(long hwnd)

SetBrightness

public long SetBrightness(long brightness)

Sets the brightness value of the attached device. This function is ignored when Smart Capture is enabled.

Parameters:

brightness - A value from 0 to 100

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode

SetLedOn

public long SetLedOn(boolean on)

Controls the LED of the fingerprint sensor.

Parameters:

on -
Allowed values:
♦ true - illuminae LEDs
♦ true - turn LEDs off

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode

GetImage

public long GetImage(byte[] buffer)

Captures a fingerprint image from the fingerprint device. The captured fingerprint is a 256 gray-level image. The image size can be retrieved by calling the JSGFPLib.getDeviceInfo() method.

Parameters:

buffer - [OUT] Byte array to store the captured image. The buffer memory must be allocated before calling getImage. Use the image width and height in FDXDeviceInfoParam to allocate the memory.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

GetDeviceInfo(SecuGen.FDxSDKPro.jni.SGDeviceInfoParam), SGFDxErrorCode, SGDeviceInfoParam.imageWidth, SGDeviceInfoParam.imageHeight

GetImageEx

public long GetImageEx(byte[] buffer,
                       long timeout,
                       long dispWnd,
                       long quality)

Captures fingerprint images from the reader until the quality of the image is greater than the value of the quality parameter. The captured fingerprint is a 256 gray-level image; image size can be retrieved by calling the SGFPM_GetDeviceInfo() function. A quality value of 50 or higher is recommended for registration. A quality value of 40 or higher is recommended for verification.

Parameters:

buffer - [OUT] Byte array to store the captured image. The buffer memory must be allocated before calling getImage. Use the image width and height in FDXDeviceInfoParam to allocate the memory.

timeout - The amount of time to allow for the image capture operation.

dispWnd - Not used in Java. Pass null for this parameter.

quality - A threshold value containing the required minimum image quality.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

GetDeviceInfo(SecuGen.FDxSDKPro.jni.SGDeviceInfoParam), SGFDxErrorCode, SGDeviceInfoParam.imageWidth, SGDeviceInfoParam.imageHeight

GetImageQuality

public long GetImageQuality(long width,
                            long height,
                            byte[] imgBuf,
                            int[] quality)

Get the quality of a fingerprint image. A quality value of 60 or higher is recommended for registration. A quality value of 40 or higher is recommended for verification.

Parameters:

width - The width of the fingerprint image being tested for quality.

height - The height of the fingerprint image being tested for quality.

imgBuf - A byte array of size width x height containing the fingerprint image to be tested for quality.

quality - [OUT] A one-dimensional array that will be populated with the image quality.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode

GetMaxTemplateSize

public long GetMaxTemplateSize(int[] size)

Get the maximum template size for the currently selected template format.

Parameters:

size - [OUT] The maximum size for the currently selected template format.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SetTemplateFormat(short), SGFDxTemplateFormat, SGFDxErrorCode

CreateTemplate

public long CreateTemplate(SGFingerInfo fpInfo,
                           byte[] rawImage,
                           byte[] minTemplate)

Create a fingerprint template using the currently selected template format.

Parameters:

fpInfo - An SGFingerinfo object containing information about the fingerprint data.

rawImage - A byte array containing a raw fingerprint image.

minTemplate - [OUT] A byte array containing a fingerprint template in the currently selected template format.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SetTemplateFormat(short), SGFDxTemplateFormat, SGFDxErrorCode, SGFingerInfo

GetTemplateSize

public long GetTemplateSize(byte[] buf,
                            int[] size)

Get the size of a fingerprint template.

Parameters:

buf - A byte array containing a fingerprint template.

size - [OUT] The size of the template.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SetTemplateFormat(short), SGFDxTemplateFormat, SGFDxErrorCode

MatchTemplate

public long MatchTemplate(byte[] minTemplate1,
                          byte[] minTemplate2,
                          long secuLevel,
                          boolean[] matched)

Get matching result of two fingerprint minutiae templates .

Parameters:

minTemplate1 - Byte array containing minutiae data sample1 extracted from a fingerprint image.

minTemplate2 - Byte array containing minutiae data sample2 extracted from a fingerprint image.

secuLevel - Security threshold for matching
Allowed values:
♦ SGFDxSecurityLevel.SL_NONE
♦ SGFDxSecurityLevel.SL_LOWEST
♦ SGFDxSecurityLevel.SL_LOWER
♦ SGFDxSecurityLevel.SL_LOW
♦ SGFDxSecurityLevel.SL_BELOW_NORMAL
♦ SGFDxSecurityLevel.SL_NORMAL
♦ SGFDxSecurityLevel.SL_ABOVE_NORMAL
♦ SGFDxSecurityLevel.SL_HIGH
♦ SGFDxSecurityLevel.SL_HIGHER
♦ SGFDxSecurityLevel.SL_HIGHEST

matched - [OUT] Boolean array with a single element containing true or false for the match result. Instantiate array before calling this method.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxSecurityLevel

GetMatchingScore

public long GetMatchingScore(byte[] minTemplate1,
                             byte[] minTemplate2,
                             int[] score)

Get matching score of two fingerprint minutiae templates.

Parameters:

minTemplate1 - Byte array containing minutiae data sample1 extracted from a fingerprint image.

minTemplate2 - Byte array containing minutiae data sample2 extracted from a fingerprint image.

score - [OUT] Integer array with a single element containing the matching score. Instantiate array before calling this method.
♦ Returned score has a value from 0 to 199.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[])

GetTemplateSizeAfterMerge

public long GetTemplateSizeAfterMerge(byte[] ansiTemplate1,
                                      byte[] ansiTemplate2,
                                      int[] size)

Get the size of the template produced by merging to templates of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378 templates.

Parameters:

ansiTemplate1 - Byte array containing ANSI378 fingerprint minutiae data.

ansiTemplate2 - Byte array containing ANSI378 fingerprint minutiae data.

size - [OUT] Integer array with a single element containing the size of the merged template. Instantiate array before calling this method.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378

MergeAnsiTemplate

public long MergeAnsiTemplate(byte[] ansiTemplate1,
                              byte[] ansiTemplate2,
                              byte[] outTemplate)

Merge two ANSI378 templates and return a merged template of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378 templates.

Parameters:

ansiTemplate1 - Byte array containing ANSI378 fingerprint minutiae data.

ansiTemplate2 - Byte array containing ANSI378 fingerprint minutiae data.

outTemplate - [OUT] Byte array containing the merged ANSI378 template. Instantiate array before calling this method

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), GetTemplateSizeAfterMerge(byte[], byte[], int[]), SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378

GetAnsiTemplateInfo

public long GetAnsiTemplateInfo(byte[] ansiTemplate,
                                SGANSITemplateInfo templateInfo)

Get the template header information for a template of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378 templates.

Parameters:

ansiTemplate - Byte array containing ANSI378 fingerprint minutiae data.

templateInfo - [OUT] SGANSITemplateInfo object containing information about all of the template data in the ANSI378 template. Instantiate object before calling this method

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGANSITemplateInfo, SGFingerInfo, SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378

MatchAnsiTemplate

public long MatchAnsiTemplate(byte[] ansiTemplate1,
                              long sampleNum1,
                              byte[] ansiTemplate2,
                              long sampleNum2,
                              long secuLevel,
                              boolean[] matched)

Get matching result of specific samples in two ANSI378 minutiae templates.

Parameters:

ansiTemplate1 - Byte array containing ANSI378 fingerprint minutiae data.

sampleNum1 - The sample in the first ANSI378 template to be used for matching. Zero based reference. The first sample is (0).

ansiTemplate2 - Byte array containing ANSI378 fingerprint minutiae data.

sampleNum2 - The sample in the second ANSI378 template to be used for matching. Zero based reference. The first sample is (0).

secuLevel - Security threshold for matching
Allowed values:
♦ SGFDxSecurityLevel.SL_NONE
♦ SGFDxSecurityLevel.SL_LOWEST
♦ SGFDxSecurityLevel.SL_LOWER
♦ SGFDxSecurityLevel.SL_LOW
♦ SGFDxSecurityLevel.SL_BELOW_NORMAL
♦ SGFDxSecurityLevel.SL_NORMAL
♦ SGFDxSecurityLevel.SL_ABOVE_NORMAL
♦ SGFDxSecurityLevel.SL_HIGH
♦ SGFDxSecurityLevel.SL_HIGHER
♦ SGFDxSecurityLevel.SL_HIGHEST

matched - [OUT] Boolean array with a single element containing true or false for the match result. Instantiate array before calling this method.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378, SGFDxSecurityLevel

GetAnsiMatchingScore

public long GetAnsiMatchingScore(byte[] ansiTemplate1,
                                 long sampleNum1,
                                 byte[] ansiTemplate2,
                                 long sampleNum2,
                                 int[] score)

Get matching score of specific samples in two ANSI378 minutiae templates.

Parameters:

ansiTemplate1 - Byte array containing ANSI378 fingerprint minutiae data.

sampleNum1 - The sample in the first ANSI378 template to be used for matching. Zero based reference. The first sample is (0).

ansiTemplate2 - Byte array containing ANSI378 fingerprint minutiae data.

sampleNum2 - The sample in the first ANSI378 template to be used for matching. Zero based reference. The first sample is (0).

score - [OUT] Integer array with a single element containing the matching score. Instantiate array before calling this method.
♦ Returned score has a value from 0 to 199.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378

GetIsoTemplateSizeAfterMerge

public long GetIsoTemplateSizeAfterMerge(byte[] isoTemplate1,
                                         byte[] isoTemplate2,
                                         int[] size)

Get the size of the template produced by merging to templates of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794 templates.

Parameters:

isoTemplate1 - Byte array containing ISO19794 fingerprint minutiae data.

isoTemplate2 - Byte array containing ISO19794 fingerprint minutiae data.

size - [OUT] Integer array with a single element containing the size of the merged template. Instantiate array before calling this method.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794

MergeIsoTemplate

public long MergeIsoTemplate(byte[] isoTemplate1,
                             byte[] isoTemplate2,
                             byte[] outTemplate)

Merge two ISO19794 templates and return a merged template of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794 templates.

Parameters:

isoTemplate1 - Byte array containing ISO19794 fingerprint minutiae data.

isoTemplate2 - Byte array containing ISO19794 fingerprint minutiae data.

outTemplate - [OUT] Byte array containing the merged ISO19794 template. Instantiate array before calling this method

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), GetTemplateSizeAfterMerge(byte[], byte[], int[]), SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794

GetIsoTemplateInfo

public long GetIsoTemplateInfo(byte[] isoTemplate,
                               SGISOTemplateInfo templateInfo)

Get the template header information for a template of the format SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794 templates.

Parameters:

isoTemplate - Byte array containing ISO19794 fingerprint minutiae data.

templateInfo - [OUT] SGISOTemplateInfo object containing information about all of the template data in the ISO19794 template. Instantiate object before calling this method

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGISOTemplateInfo, SGFingerInfo, SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794

MatchIsoTemplate

public long MatchIsoTemplate(byte[] isoTemplate1,
                             long sampleNum1,
                             byte[] isoTemplate2,
                             long sampleNum2,
                             long secuLevel,
                             boolean[] matched)

Get matching result of specific samples in two ISO19794 minutiae templates.

Parameters:

isoTemplate1 - Byte array containing ISO19794 fingerprint minutiae data.

sampleNum1 - The sample in the first ISO19794 template to be used for matching. Zero based reference. The first sample is (0).

isoTemplate2 - Byte array containing ISO19794 fingerprint minutiae data.

sampleNum2 - The sample in the first ISO19794 template to be used for matching. Zero based reference. The first sample is (0).

secuLevel - Security threshold for matching
Allowed values:
♦ SGFDxSecurityLevel.SL_NONE
♦ SGFDxSecurityLevel.SL_LOWEST
♦ SGFDxSecurityLevel.SL_LOWER
♦ SGFDxSecurityLevel.SL_LOW
♦ SGFDxSecurityLevel.SL_BELOW_NORMAL
♦ SGFDxSecurityLevel.SL_NORMAL
♦ SGFDxSecurityLevel.SL_ABOVE_NORMAL
♦ SGFDxSecurityLevel.SL_HIGH
♦ SGFDxSecurityLevel.SL_HIGHER
♦ SGFDxSecurityLevel.SL_HIGHEST

matched - [OUT] Boolean array with a single element containing true or false for the match result. Instantiate array before calling this method.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794, SGFDxSecurityLevel

GetIsoMatchingScore

public long GetIsoMatchingScore(byte[] isoTemplate1,
                                long sampleNum1,
                                byte[] isoTemplate2,
                                long sampleNum2,
                                int[] score)

Get matching score of specific samples in two ISO19794 minutiae templates.

Parameters:

isoTemplate1 - Byte array containing ISO19794 fingerprint minutiae data.

sampleNum1 - The sample in the first ISO19794 template to be used for matching. Zero based reference. The first sample is (0).

isoTemplate2 - Byte array containing ISO19794 fingerprint minutiae data.

sampleNum2 - The sample in the second ISO19794 template to be used for matching. Zero based reference. The first sample is (0).

score - [OUT] Integer array with a single element containing the matching score. Instantiate array before calling this method.
♦ Returned score has a value from 0 to 199.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794

MatchTemplateEx

public long MatchTemplateEx(byte[] minTemplate1,
                            short tempateType1,
                            long sampleNum1,
                            byte[] minTemplate2,
                            short tempateType2,
                            long sampleNum2,
                            long secuLevel,
                            boolean[] matched)

Get matching result of specific samples in two minutiae templates of any type.

Parameters:

minTemplate1 - Byte array containing ISO19794 fingerprint minutiae data.

tempateType1 - The type of the first template.
Allowed values:
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_SG400
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794

sampleNum1 - The sample in the first template to be used for matching. Zero based reference. The first sample is (0).

minTemplate2 - Byte array containing ISO19794 fingerprint minutiae data.

tempateType2 - The type of the first template.
Allowed values:
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_SG400
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794

sampleNum2 - The sample in the second template to be used for matching. Zero based reference. The first sample is (0).

secuLevel - Security threshold for matching
Allowed values:
♦ SGFDxSecurityLevel.SL_NONE
♦ SGFDxSecurityLevel.SL_LOWEST
♦ SGFDxSecurityLevel.SL_LOWER
♦ SGFDxSecurityLevel.SL_LOW
♦ SGFDxSecurityLevel.SL_BELOW_NORMAL
♦ SGFDxSecurityLevel.SL_NORMAL
♦ SGFDxSecurityLevel.SL_ABOVE_NORMAL
♦ SGFDxSecurityLevel.SL_HIGH
♦ SGFDxSecurityLevel.SL_HIGHER
♦ SGFDxSecurityLevel.SL_HIGHEST

matched - [OUT] Boolean array with a single element containing true or false for the match result. Instantiate array before calling this method.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat, SGFDxSecurityLevel

GetMatchingScoreEx

public long GetMatchingScoreEx(byte[] minTemplate1,
                               short tempateType1,
                               long sampleNum1,
                               byte[] minTemplate2,
                               short tempateType2,
                               long sampleNum2,
                               int[] score)

Get matching score of specific samples in two minutiae templates of any type.

Parameters:

minTemplate1 - Byte array containing ISO19794 fingerprint minutiae data.

tempateType1 - The type of the first template.
Allowed values:
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_SG400
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794

sampleNum1 - The sample in the first template to be used for matching. Zero based reference. The first sample is (0).

minTemplate2 - Byte array containing ISO19794 fingerprint minutiae data.

tempateType2 - The type of the first template.
Allowed values:
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_SG400
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794

sampleNum2 - The sample in the second template to be used for matching. Zero based reference. The first sample is (0).

score - [OUT] Integer array with a single element containing the matching score. Instantiate array before calling this method.
♦ Returned score has a value from 0 to 199.

Returns:

♦ SGFDxErrorCode.ERROR_NONE on success.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat

GetMinexVersion

public long GetMinexVersion(int[] extractor,
                            int[] matcher)

Gets version of MINEX Compliant algorithms used in this SDK.

Parameters:

extractor - Version of MINEX Compliant extractor (template generator).

matcher - Version of MINEX Compliant matcher (template matcher)

See Also:

SGFDxErrorCode

ComputeNFIQ

public long ComputeNFIQ(byte[] imgBuf,
                        long width,
                        long height)

Compute NIST Fingerprint Image Quality score for a 500DPI 8 bit grayscale fingerprint image.

Parameters:

imgBuf - Byte array containing a raw fingerprint image.

width - The width of the image in pixels.

height - The height of the image in pixels.

Returns:

NFIQ score for the image that was processed
1 = highest quality fingerprint image
2 = high quality fingerprint image
3 = medium quality fingerprint image
4 = low quality fingerprint image
5 = lowest quality fingerprint image
-1 = An error occurred

ComputeNFIQEx

public long ComputeNFIQEx(byte[] imgBuf,
                          long width,
                          long height,
                          long ppi)

Compute NIST Fingerprint Image Quality score for an 8 bit grayscale fingerprint image.

Parameters:

imgBuf - Byte array containing a raw fingerprint image.

width - The width of the image in pixels.

height - The height of the image in pixels.

ppi - The resolution of the image in pixels per inch.

Returns:

NFIQ score for the image that was processed
1 = highest quality fingerprint image
2 = high quality fingerprint image
3 = medium quality fingerprint image
4 = low quality fingerprint image
5 = lowest quality fingerprint image
-1 = An error occurred

WSQGetDecodedImageSize

public long WSQGetDecodedImageSize(int[] fingerImageOutSize,
                                   byte[] wsqImage,
                                   int wsqImageSize)

Get the size of the RAW image contained in the WSQ image file. This function must be called before WSQDecode is called to allocate the size needed for the fingerimageOut buffer that will be populated with the raw image.

Parameters:

fingerImageOutSize - Integer array that will be populated with the size of the RAW image.

wsqImage - Byte array containing the WSQ image.

wsqImageSize - The size of the WSQ image file.

WSQDecode

public long WSQDecode(byte[] fingerImageOut,
                      int[] width,
                      int[] height,
                      int[] pixelDepth,
                      int[] ppi,
                      int[] lossyFlag,
                      byte[] wsqImage,
                      int wsqImageSize)

Decode the WSQ image and return the RAW image. WSQGetDecodedImageSize() must be called first to allocate the size needed for the fingerimageOut buffer that will be populated with the raw image.

Parameters:

fingerImageOut - Byte array that will be populated with the RAW image.

width - Integer array that will be populated with the RAW image width.

height - Integer array that will be populated with the RAW image height.

pixelDepth - Integer array that will be populated with the RAW image pixelDepth. Example 8 bits per pixel.

ppi - Integer array that will be populated with the RAW image resolution. Example 500 ppi.

lossyFlag - Integer array that will be populated with the RAW image width.

wsqImage - Byte array containing the WSQ image.

wsqImageSize - The size of the WSQ image file.

WSQGetEncodedImageSize

public long WSQGetEncodedImageSize(int[] wsqImageOutSize,
                                   float wsqBitRate,
                                   byte[] fingerImage,
                                   int width,
                                   int height,
                                   int pixelDepth,
                                   int ppi)

Get the size of the compressed WSQ image that will be returned when the RAW image file is compressed. This function must be called before WSQEncode() is called to allocate the size needed for the wsqImageOut buffer that will be populated with the raw image.

Parameters:

wsqImageOutSize - Integer array that will be populated with the size of the WSQ image.

wsqBitRate - Compression bitrate to be used. Either BITRATE_5_TO_1 or BITRATE_15_TO_1.

fingerImage - Byte array containing a raw fingerprint image.

width - Width of the raw image in pixels.

height - Height of the raw image in pixels.

pixelDepth - Pixel depth of the image. Example - 8 bits per pixel.

ppi - Image resolution.

See Also:

SGWSQLib

WSQEncode

public long WSQEncode(byte[] wsqImageOut,
                      float wsqBitRate,
                      byte[] fingerImage,
                      int width,
                      int height,
                      int pixelDepth,
                      int ppi)

Encode a WSQ image. WSQGetEncodedImageSize() must be called first to determine the size to be allocated for the wsqImageOut buffer.

Parameters:

wsqImageOut - Byte array that will be populated with the WSQ image.

wsqBitRate - Compression bitrate to be used. Either BITRATE_5_TO_1 or BITRATE_15_TO_1.

fingerImage - Byte array containing a raw fingerprint image.

width - Width of the raw image in pixels.

height - Height of the raw image in pixels.

pixelDepth - Pixel depth of the image. Example - 8 bits per pixel.

ppi - Image resolution.

See Also:

SGWSQLib

GetNumOfMinutiae

public long GetNumOfMinutiae(short templateType,
                             byte[] minTemplate,
                             int[] numOfMinutiae)

Get a count of the number of minutiae in a fingerprint template.

Parameters:

templateType - The type of the first template.
Allowed values:
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ANSI378
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_ISO19794
♦ SGFDxTemplateFormat.TEMPLATE_FORMAT_SG400

minTemplate - Byte array containing fingerprint minutiae data.

numOfMinutiae - [OUT] Integer array with a single element containing the number of minutiae. Instantiate array before calling this method.

See Also:

SGFDxErrorCode, CreateTemplate(SecuGen.FDxSDKPro.jni.SGFingerInfo, byte[], byte[]), SGFDxTemplateFormat, SGFDxSecurityLevel